Begins a render pass in the command stream. More...

#include <kanzi/gfx/commands.hpp>

Inheritance diagram for kanzi::gfx::BeginRenderPassCommand:

Public Member Functions
	BeginRenderPassCommand ()
	Constructor.

Public Member Functions inherited from kanzi::gfx::BaseCommand
uint32_t	getSize () const
	Gets the command size in bytes.

uint8_t	getTag () const
	Gets the command tag.

CommandType	getType () const
	Gets the command type.

void	setTag (uint8_t tag)
	Sets the command tag.

Public Attributes
array< optional< ColorClearValue >, limits::MaxColorAttachments >	clearColors
	An array of clear colors to use for each attachment.

optional< float >	clearDepth
	An optional depth clear value.

optional< uint32_t >	clearStencil
	An optional stencil clear value.

FrameBufferHandleGuard	frameBuffer
	The frame buffer for the render pass to render to.

RenderPassHandleGuard	renderPass
	The render pass to begin.

rects32	scissor
	The scissor area clamped to the frame buffer extents. The default is the entire frame buffer.

rects32	viewport
	The viewport rectangle clamped to the frame buffer extents. The default is the entire frame buffer.

Additional Inherited Members
Protected Member Functions inherited from kanzi::gfx::BaseCommand
	BaseCommand (CommandType t, uint32_t s)
	Constructor.

	BaseCommand (const BaseCommand &other)
	Copy Constructor.

BaseCommand &	operator= (const BaseCommand &other)
	Assignment operator.

Detailed Description

Begins a render pass in the command stream.

Requires a matching EndRenderPassCommand when the render pass is complete.

Since: Kanzi 4.0.0

Constructor & Destructor Documentation

◆ BeginRenderPassCommand()

kanzi::gfx::BeginRenderPassCommand::BeginRenderPassCommand ( )

inline

Constructor.

Member Data Documentation

◆ renderPass

RenderPassHandleGuard kanzi::gfx::BeginRenderPassCommand::renderPass

The render pass to begin.

◆ frameBuffer

FrameBufferHandleGuard kanzi::gfx::BeginRenderPassCommand::frameBuffer

The frame buffer for the render pass to render to.

This must be compatible with the attachment description set of the render pass.

◆ viewport

rects32 kanzi::gfx::BeginRenderPassCommand::viewport

The viewport rectangle clamped to the frame buffer extents. The default is the entire frame buffer.

◆ scissor

rects32 kanzi::gfx::BeginRenderPassCommand::scissor

The scissor area clamped to the frame buffer extents. The default is the entire frame buffer.

◆ clearColors

array<optional<ColorClearValue>, limits::MaxColorAttachments> kanzi::gfx::BeginRenderPassCommand::clearColors

An array of clear colors to use for each attachment.

These colors override the clear color specified in the render pass create info struct.

◆ clearDepth

optional<float> kanzi::gfx::BeginRenderPassCommand::clearDepth

An optional depth clear value.

This overrides the clear value specified in the render pass create info struct.

◆ clearStencil

optional<uint32_t> kanzi::gfx::BeginRenderPassCommand::clearStencil

An optional stencil clear value.